Xero - Submitting your journal using API

Using API technology, BrightPay offers full integration with Xero allowing both the payroll software and accounting software system to directly communicate with each other.

BrightPay will produce the payroll journal in a file format that is unique to Xero, allowing users to easily send their payroll figures into their general ledger. The BrightPay API facility eliminates the manual export and import process, automating tedious, repetitive and time-consuming tasks.

By using BrightPay and Xero together, users will be able to increase efficiency, avoid duplication of efforts and reduce the possibility of manual processing errors.

How does the BrightPay and Xero integration work?

• When you sign into your Xero account in BrightPay, your chart of accounts will be retrieved from Xero
  
  
• Using this chart of accounts, map each payroll data item to the relevant nominal account
  
  
• Based on the mapping applied, simply submit your journal to Xero
  
  
  

Submitting your payroll journal from BrightPay to Xero using API

1) Within Payroll, select Journal on the menu toolbar, followed by Xero:

2a) On the next screen, choose Xero API as your destination


b) Set your Date Range - the journal will include records for all payslips (across all pay frequencies) with a pay date within the selected range. 

c) Roll up - select whether you would like the journal to include individual records for each employee or whether to merge the records for each unique date.


d) Enter the 'Tax Rate' name required, if different from the default of 'Tax Exempt (0%)'

e) Should you wish to include the employee's department name as the tracking option value, tick the box provided. Should the tracking category name differ to 'Department', enter accordingly.

f) Click Connect to Xero. Sign into your Xero account if prompted to do so.

3a) Nominal Ledger Mapping - your nominal ledger codes will now be retrieved from Xero.

Simply map each payroll data item to the relevant nominal account code. A nominal account code can be used for multiple items.

b) When ready to proceed, click 'Continue'. 

4) Nominal Ledger Mapping - Variations - this screen allows you to specify any circumstances for which amounts should be mapped to an alternate nominal account code (e.g. depending on period type, directorship, departments, specific rates/additions/deductions, etc.)

a) For each payroll data item you wish to add a variation for, click Add Variation:

b) For the payroll data item selected, set the rules to apply in order for the amount to be mapped to the designated nominal account you enter on this screen.

Rules can be set according to period type, directorship, department and specific pay items.

Example

You wish the salaries of all directors within the Accounting department to be mapped to the Director's Remuneration nominal account within your accounting software. Your rules may thus be set as follows:

 c) Click Save when complete.

Your rule will now be displayed on screen under the payroll data item it is associated with.

d) Further variations can be added for different pay items or for the same payroll data item by simply clicking Add Variation again and setting the rules to apply.

e) Once variations have been set, these can be edited, deleted or re-ordered by clicking the spanner symbol next to it. In addition, clicking the nominal account information displayed in green provides quick access to the rules that have been set for it.




 

f) On completion of this screen (where required), click 'Continue'.

Your journal will now be displayed on screen for review. Simply click the 'Back' button to make any amendments. 

5a) When ready to upload your journal into Xero, click  'Send to Xero...' 

b) Confirmation will be displayed on screen to confirm successful upload into your Xero account.

c) Press 'Print' to print, email or export a copy of your journal to PDF.

d) To close the journal screen, simply click the cross at the top right of this screen. If you have made any changes to the journal, you will be asked if you wish to save your changes. Click 'Yes' or 'No' as required.

Additional Note

Please note: Employment Allowance and Recoverable Amounts are not catered for in the journal API.

Therefore a manual journal within your accounts software will be required, where applicable.